Skip to main content

XPDFViewer_Select

Type

command

Summary

Set the current selection of the PDF Viewer to a specific range.

Syntax

XPDFViewer_Select <viewerName>, <startPageNumber>, <startCharOnPage>, <endPageNumber>, <endCharOnPage>

Description

The function returns the range as startPageNumber, startCharOnPage, endPageNumber, endCharOnPage. Insertion point is returned as start page number, char insertion point is after, endPageNumber - same as start, char insertion point is after - 1

If item 1 = item 3 AND item 4 < item 2 then it is an insertion point position.

The function will return empty if there is no selection.

The following errors may be thrown by the command:

  • XPDF_ERROR: incorrect number of parameters
  • XPDF_ERROR: PDF viewer not found

Parameters

NameTypeDescription

viewerName

string

The name of the viewer.

startPageNumber

integer

The page where selection begins.

startCharOnPage

integer

The character index (1..N) of the first selected character.

endPageNumber

integer

The page where selection ends. endCharOnPage> (integer): The character index (1..N) of the last selected character.

Examples

XPDFViewer_Select "Document1", 1, 300, 3, 20
// Clear the selection
XPDFViewer_Select "Document1",""

Compatibility and Support

Introduced

LiveCode 1.0.0

OS

mac

windows

Platforms

desktop

Thank you for your feedback!

Was this page helpful?